TQueryParamMapping

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > Remotable Records > TQueryParamMapping

## TQueryParamMapping

The TQueryParamMapping Class is used to define the HTTP GET Query Parameters mappings.

class TQueryParamMapping : public TRemotable {

public:

int FQueryParamNameMapID;

AnsiString FPNameEndUserName;

AnsiString FPNameEndUserCompanyName;

AnsiString FPNameEndUserReferrer;

AnsiString FPNameEndUserIP;

AnsiString FPNameEndUserAddress1;

AnsiString FPNameEndUserAddress2;

AnsiString FPNameEndUserAddress3;

AnsiString FPNameEndUserPhone;

AnsiString FPNameEndUserEmail;

AnsiString FPNameEndUserPassword;

AnsiString FPNameGenSerialNo;

AnsiString FPNameOrderNo;

bool FDeleted;

__fastcall TQueryParamMapping();

__published:

__property int QueryParamNameMapID = { read=FQueryParamNameMapID, write=FQueryParamNameMapID };

__property AnsiString PNameEndUserCompanyName = { read=FPNameEndUserCompanyName, write=FPNameEndUserCompanyName };

__property AnsiString PNameEndUserName = { read=FPNameEndUserName, write=FPNameEndUserName };

__property AnsiString PNameEndUserReferrer = { read=FPNameEndUserReferrer, write=FPNameEndUserReferrer };

__property AnsiString PNameEndUserIP = { read=FPNameEndUserIP, write=FPNameEndUserIP };

__property AnsiString PNameEndUserAddress1 = { read=FPNameEndUserAddress1, write=FPNameEndUserAddress1 };

__property AnsiString PNameEndUserAddress2 = { read=FPNameEndUserAddress2, write=FPNameEndUserAddress2 };

__property AnsiString PNameEndUserAddress3 = { read=FPNameEndUserAddress3, write=FPNameEndUserAddress3 };

__property AnsiString PNameEndUserPhone = { read=FPNameEndUserPhone, write=FPNameEndUserPhone };

__property AnsiString PNameEndUserEmail = { read=FPNameEndUserEmail, write=FPNameEndUserEmail };

__property AnsiString PNameEndUserPassword = {read=FPNameEndUserPassword, write=FPNameEndUserPassword };

__property AnsiString PNameGenSerialNo = { read=FPNameGenSerialNo, write=FPNameGenSerialNo };

__property AnsiString PNameOrderNo = { read=FPNameOrderNo, write=FPNameOrderNo };

__property bool Deleted = { read=FDeleted, write=FDeleted };

};

There are cases when developers do not have control over what parameters are used in an HTTP Get situation. This is when parameter mapping is useful.

For Example: If you are using a third party Online Shop, the Order number may be returned as "orderNumber=0001", but Checkpoint only accepts "orderNo". In this situation you can use QueryMapping to Map "orderNumber" so that it could be recognized and translated to "orderNo".

It is recommended that you read the section Map CheckPoint HTTP GET Query Parameters to have a better understand of Query Parameters.

Also refer to Generating Serial Numbers Dynamically to understand what each parameter is used for.

The meaning of a particular TQueryParamMapping depends on the context from which it was used.

The following descriptions of meaning is meant as a guide:

#### TQueryParamMapping Property:

QueryParamNameMapID : This property represents the Query Parameter Id that is associated to this record

PNameEndUserCompanyName : This property maps to CPEUCONM

PNameEndUserName : This property maps to CPEUNAME

PNameEndUserReferrer : This property maps to CPEUREF

PNameEndUserIP : This property maps to CPEUIP

PNameEndUserAddress1 : This property maps to CPEUA1

PNameEndUserAddress2 : This property maps to CPEUA2

PNameEndUserAddress3 : This property maps to CPEUA3

PNameEndUserPhone : This property maps to CPEUPH

PNameEndUserEmail : This property maps to CPEUEM

PNameEndUserPassword : This property maps to CPEUPW

PNameGenSerialNo : This is a special parameter that allows you to compress multiple other URL Encoded parameters in this list into a single parameter value

PNameOrderNo : This property maps to CPONO

Deleted : This property defines if this entry is deleted.

#

#